VOID Payment

This API is used to void an existing payment transaction. It is identified by a referenceId and must be associated with the same program and customerId.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method	String RPC method name (e.g., TransactionService.Payment)
id	String Unique ID for the request
params.api	Object API authentication block
params.api.signature	String Encrypted signature
params.api.keyId	String Device ID used for authentication
params.api.credential	String Credential string (e.g., Basic Auth)
params.api.apiKey	String API Key
params.payload.type	String Should be VOID
params.payload.product	String Product type (e.g., PL)
params.payload.program	String Program ID
params.payload.referenceId	String Reference ID of original transaction
params.payload.customerId	String Customer ID
params.payload.notes	String Description or reason for voiding the payment

cURL

curl --location 'http://localhost:5010/PL/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{
  "method": "TransactionService.Payment",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{DeviceID}}",
      "credential": "{{Credential}}",
      "apiKey": "{{ApiKey}}"
    },
    "payload": {
      "type": "VOID",
      "product": "PL",
      "program": "100000000045001",
      "referenceId": "REF100223457",
      "customerId": "100000000045001",
      "notes": "void payment"
    }
  }
}'

Body

{
  "method": "TransactionService.Payment",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{DeviceID}}",
      "credential": "{{Credential}}",
      "apiKey": "{{ApiKey}}"
    },
    "payload": {
      "type": "VOID",
      "product": "PL",
      "program": "100000000045001",
      "referenceId": "REF100223457",
      "customerId": "100000000045001",
      "notes": "void payment"
    }
  }
}

Response: 200

Payload Parameters

Parameter	Description
Status	String Status of the void request (e.g., COMPLETED)
TransactionID	String Unique ID for the void transaction
referenceID	String New reference ID assigned to the void
isPartial	Boolean Indicates if the void was partially successful

{
  "id": "1",
  "result": {
    "status": "COMPLETED",
    "TransactionID": "19472113",
    "referenceID": "1746442043379",
    "isPartial": false
  },
  "jsonrpc": "2.0"
}